Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use custom template for datacard header #24

Merged
merged 4 commits into from
Dec 9, 2024
Merged

Use custom template for datacard header #24

merged 4 commits into from
Dec 9, 2024

Conversation

hagenw
Copy link
Member

@hagenw hagenw commented Dec 9, 2024

This limits what is presented in the datacard header, and also ensures that the dataset overview page is presented in wide format.

image

Summary by Sourcery

Implement a custom template for the datacard header to limit displayed information and update the documentation configuration to support wide format for dataset overview pages.

Enhancements:

  • Implement a custom template for the datacard header to limit displayed information.

Documentation:

  • Update documentation configuration to include wide format for dataset overview pages.

Copy link

sourcery-ai bot commented Dec 9, 2024

Reviewer's Guide by Sourcery

The changes customize the datacard header template and configure the documentation settings to display dataset overview pages in wide format. This is implemented by adding a custom template directory and updating the theme configuration.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added custom template for datacard header
  • Created new template file with customized header layout
  • Configured audbcards to use custom templates directory
docs/_templates/datacard_header.j2
docs/conf.py
Updated documentation configuration
  • Added 'datasets' to wide_pages list in theme configuration
  • Updated audbcards dependency to version >= 0.3.3
docs/conf.py
docs/requirements.txt

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @hagenw - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@hagenw hagenw merged commit 4792db9 into main Dec 9, 2024
2 checks passed
@hagenw hagenw deleted the update-audbcards branch December 9, 2024 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant